Cisco-IOS-XR-ethernet-link-oam-cfg API API Reference
API generated from Cisco-IOS-XR-ethernet-link-oam-cfg@2015-11-09.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
Key  Mandatory  OptionalPaths
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
ENCRYPTED-COMMUNITY-MAPS - Update
Update operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Create
Create operation of resource: encrypted-community-maps
encrypted-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Delete
Delete operation of resource: encrypted-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: encrypted-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
ENCRYPTED-COMMUNITY-MAP - Update
Update operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Create
Create operation of resource: encrypted-community-map
encrypted-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Delete
Delete operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: encrypted-community-map
ID of community-name
Successful operation
Internal Error
VIEWS - Update
Update operation of resource: views
viewsbody object
Request Content-Types: application/json
Request Example
{ {
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Create
Create operation of resource: views
viewsbody object
Request Content-Types: application/json
Request Example
{ {
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Delete
Delete operation of resource: views
Successful operation
Internal Error
Response Content-Types: application/json
VIEWS - Retrieve
Retrieve operation of resource: views
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
}
]
}
}
VIEW - Update
Update operation of resource: view
viewbody object
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Create
Create operation of resource: view
viewbody object
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Delete
Delete operation of resource: view
ID of view-name family
Successful operation
Internal Error
Response Content-Types: application/json
VIEW - Retrieve
Retrieve operation of resource: view
ID of view-name family
Successful operation
Internal Error
LOGGING - Update
Update operation of resource: logging
loggingbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Create
Create operation of resource: logging
loggingbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Delete
Delete operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
LOGGING - Retrieve
Retrieve operation of resource: logging
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
Request Content-Types: application/json
Request Example
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
}
}
ADMINISTRATION - Update
Update operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}, {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Create
Create operation of resource: administration
administrationbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}, {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Delete
Delete operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
ADMINISTRATION - Retrieve
Retrieve operation of resource: administration
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}, {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
}
DEFAULT-COMMUNITIES - Update
Update operation of resource: default-communities
default-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Create
Create operation of resource: default-communities
default-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Delete
Delete operation of resource: default-communities
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITIES - Retrieve
Retrieve operation of resource: default-communities
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
DEFAULT-COMMUNITY - Update
Update operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Create
Create operation of resource: default-community
default-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Delete
Delete operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY - Retrieve
Retrieve operation of resource: default-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
ENCRYPTED-COMMUNITIES - Update
Update operation of resource: encrypted-communities
encrypted-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Create
Create operation of resource: encrypted-communities
encrypted-communitiesbody object
Request Content-Types: application/json
Request Example
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Delete
Delete operation of resource: encrypted-communities
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-communities
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
]
}
}
ENCRYPTED-COMMUNITY - Update
Update operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Create
Create operation of resource: encrypted-community
encrypted-communitybody object
ID of community-name
Request Content-Types: application/json
Request Example
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Delete
Delete operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-community
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
}
}
AGENT - Update
Update operation of resource: agent
agentbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Create
Create operation of resource: agent
agentbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Delete
Delete operation of resource: agent
Successful operation
Internal Error
Response Content-Types: application/json
AGENT - Retrieve
Retrieve operation of resource: agent
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
}
ENGINE-ID - Update
Update operation of resource: engine-id
engine-idbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Create
Create operation of resource: engine-id
engine-idbody object
Request Content-Types: application/json
Request Example
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Delete
Delete operation of resource: engine-id
Successful operation
Internal Error
Response Content-Types: application/json
ENGINE-ID - Retrieve
Retrieve operation of resource: engine-id
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
},
"local": "string" engineID of the local agent
}
}
REMOTES - Update
Update operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Create
Create operation of resource: remotes
remotesbody object
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Delete
Delete operation of resource: remotes
Successful operation
Internal Error
Response Content-Types: application/json
REMOTES - Retrieve
Retrieve operation of resource: remotes
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
}
]
}
}
REMOTE - Update
Update operation of resource: remote
remotebody object
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Create
Create operation of resource: remote
remotebody object
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Delete
Delete operation of resource: remote
ID of remote-address
Successful operation
Internal Error
Response Content-Types: application/json
REMOTE - Retrieve
Retrieve operation of resource: remote
ID of remote-address
Successful operation
Internal Error
TRAP - Update
Update operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{ "queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Create
Create operation of resource: trap
trapbody object
Request Content-Types: application/json
Request Example
{ "queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Delete
Delete operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
TRAP - Retrieve
Retrieve operation of resource: trap
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"
}
}
DROP-PACKET - Update
Update operation of resource: drop-packet
drop-packetbody object
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Create
Create operation of resource: drop-packet
drop-packetbody object
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Delete
Delete operation of resource: drop-packet
Successful operation
Internal Error
Response Content-Types: application/json
DROP-PACKET - Retrieve
Retrieve operation of resource: drop-packet
Successful operation
Internal Error
IPV6 - Update
Update operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Create
Create operation of resource: ipv6
ipv6body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Delete
Delete operation of resource: ipv6
Successful operation
Internal Error
Response Content-Types: application/json
IPV6 - Retrieve
Retrieve operation of resource: ipv6
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
IPV4 - Update
Update operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Create
Create operation of resource: ipv4
ipv4body object
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Delete
Delete operation of resource: ipv4
Successful operation
Internal Error
Response Content-Types: application/json
IPV4 - Retrieve
Retrieve operation of resource: ipv4
Successful operation
Internal Error
TOS - Update
Update operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Create
Create operation of resource: tos
tosbody object
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Delete
Delete operation of resource: tos
Successful operation
Internal Error
Response Content-Types: application/json
TOS - Retrieve
Retrieve operation of resource: tos
Successful operation
Internal Error
SYSTEM - Update
Update operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{ "chassis-id": "string", String to uniquely identify this chassis
"contact": "string", identification of the contact person for this\nmanaged node
"location": "string" The physical location of this node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Create
Create operation of resource: system
systembody object
Request Content-Types: application/json
Request Example
{ "chassis-id": "string", String to uniquely identify this chassis
"contact": "string", identification of the contact person for this\nmanaged node
"location": "string" The physical location of this node
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Delete
Delete operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
SYSTEM - Retrieve
Retrieve operation of resource: system
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "chassis-id": "string", String to uniquely identify this chassis
"contact": "string", identification of the contact person for this\nmanaged node
"location": "string" The physical location of this node
}
}
TARGET - Update
Update operation of resource: target
targetbody object
Request Content-Types: application/json
Request Example
{ : {SNMP Target address configurations : [No description {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list : {List of VRF Name for a target list : [No description {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
Request Content-Types: application/json
Request Example
{ : {SNMP Target address configurations : [No description {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list : {List of VRF Name for a target list : [No description {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {SNMP Target address configurations : [No description {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list : {List of VRF Name for a target list : [No description {
"name": "string" VRF Name
}
]
}
}
}
TARGETS - Update
Update operation of resource: targets
targetsbody object
Request Content-Types: application/json
Request Example
{ { {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Create
Create operation of resource: targets
targetsbody object
Request Content-Types: application/json
Request Example
{ { {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Delete
Delete operation of resource: targets
Successful operation
Internal Error
Response Content-Types: application/json
TARGETS - Retrieve
Retrieve operation of resource: targets
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
]
}
}
TARGET - Update
Update operation of resource: target
targetbody object
ID of target-list-name
Request Content-Types: application/json
Request Example
{ {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Create
Create operation of resource: target
targetbody object
ID of target-list-name
Request Content-Types: application/json
Request Example
{ {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Delete
Delete operation of resource: target
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET - Retrieve
Retrieve operation of resource: target
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"ip-address": "string" IPv4/Ipv6 address
}
]
},
"target-list-name": "string", Name of the target list {
"name": "string" VRF Name
}
]
}
}
}
VRF-NAMES - Update
Update operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Create
Create operation of resource: vrf-names
vrf-namesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Delete
Delete operation of resource: vrf-names
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAMES - Retrieve
Retrieve operation of resource: vrf-names
ID of target-list-name
VRF-NAME - Update
Update operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Create
Create operation of resource: vrf-name
vrf-namebody object
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Delete
Delete operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF-NAME - Retrieve
Retrieve operation of resource: vrf-name
ID of target-list-name
ID of name
Successful operation
Internal Error
TARGET-ADDRESSES - Update
Update operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Create
Create operation of resource: target-addresses
target-addressesbody object
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Delete
Delete operation of resource: target-addresses
ID of target-list-name
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESSES - Retrieve
Retrieve operation of resource: target-addresses
ID of target-list-name
TARGET-ADDRESS - Update
Update operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Create
Create operation of resource: target-address
target-addressbody object
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Delete
Delete operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TARGET-ADDRESS - Retrieve
Retrieve operation of resource: target-address
ID of target-list-name
ID of ip-address
Successful operation
Internal Error
NOTIFICATION - Update
Update operation of resource: notification
notificationbody object
Request Content-Types: application/json
Request Example
{ "status": "null", Enable cvplsStatusChanged notification
"full-raise": "null", Enable cvplsFwdFullAlarmRaised notification
"enable": "null", Enable CISCO-IETF-PW-MIB notifications
"full-clear": "null" Enable cvplsFwdFullAlarmCleared notification
}, "enable": "null" Enable CISCO-IETF-PW-MIB notifications
}, "authentication": "null", Enable authentication notification
"enable": "null", Enable CISCO-IETF-PW-MIB notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}, "vc-up": "null", Enable cpwVcUp notification
"vc-down": "null", Enable cpwVcDown notification
"enable": "null", Enable CISCO-IETF-PW-MIB notifications
"cisco": "null" Enable Cisco format including extra varbinds
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Create
Create operation of resource: notification
notificationbody object
Request Content-Types: application/json
Request Example
{ "status": "null", Enable cvplsStatusChanged notification
"full-raise": "null", Enable cvplsFwdFullAlarmRaised notification
"enable": "null", Enable CISCO-IETF-PW-MIB notifications
"full-clear": "null" Enable cvplsFwdFullAlarmCleared notification
}, "enable": "null" Enable CISCO-IETF-PW-MIB notifications
}, "authentication": "null", Enable authentication notification
"enable": "null", Enable CISCO-IETF-PW-MIB notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}, "vc-up": "null", Enable cpwVcUp notification
"vc-down": "null", Enable cpwVcDown notification
"enable": "null", Enable CISCO-IETF-PW-MIB notifications
"cisco": "null" Enable Cisco format including extra varbinds
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Delete
Delete operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
NOTIFICATION - Retrieve
Retrieve operation of resource: notification
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "status": "null", Enable cvplsStatusChanged notification
"full-raise": "null", Enable cvplsFwdFullAlarmRaised notification
"enable": "null", Enable CISCO-IETF-PW-MIB notifications
"full-clear": "null" Enable cvplsFwdFullAlarmCleared notification
}, "enable": "null" Enable CISCO-IETF-PW-MIB notifications
}, "authentication": "null", Enable authentication notification
"enable": "null", Enable CISCO-IETF-PW-MIB notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}, "vc-up": "null", Enable cpwVcUp notification
"vc-down": "null", Enable cpwVcDown notification
"enable": "null", Enable CISCO-IETF-PW-MIB notifications
"cisco": "null" Enable Cisco format including extra varbinds
}
}
}
SNMP - Update
Update operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Create
Create operation of resource: snmp
snmpbody object
Request Content-Types: application/json
Request Example
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Delete
Delete operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
SNMP - Retrieve
Retrieve operation of resource: snmp
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
}
}
VPLS - Update
Update operation of resource: vpls
vplsbody object
Request Content-Types: application/json
Request Example
{ "status": "null", Enable cvplsStatusChanged notification
"full-raise": "null", Enable cvplsFwdFullAlarmRaised notification
"enable": "null", Enable CISCO-IETF-VPLS-GENERIC-MIB\nnotifications
"full-clear": "null" Enable cvplsFwdFullAlarmCleared notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VPLS - Create
Create operation of resource: vpls
vplsbody object
Request Content-Types: application/json
Request Example
{ "status": "null", Enable cvplsStatusChanged notification
"full-raise": "null", Enable cvplsFwdFullAlarmRaised notification
"enable": "null", Enable CISCO-IETF-VPLS-GENERIC-MIB\nnotifications
"full-clear": "null" Enable cvplsFwdFullAlarmCleared notification
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VPLS - Delete
Delete operation of resource: vpls
Successful operation
Internal Error
Response Content-Types: application/json
VPLS - Retrieve
Retrieve operation of resource: vpls
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "status": "null", Enable cvplsStatusChanged notification
"full-raise": "null", Enable cvplsFwdFullAlarmRaised notification
"enable": "null", Enable CISCO-IETF-VPLS-GENERIC-MIB\nnotifications
"full-clear": "null" Enable cvplsFwdFullAlarmCleared notification
}
}
L2VPN - Update
Update operation of resource: l2vpn
l2vpnbody object
Request Content-Types: application/json
Request Example
{ "vc-up": "null", Enable cpwVcUp notification
"vc-down": "null", Enable cpwVcDown notification
"enable": "null", Enable CISCO-IETF-PW-MIB notifications
"cisco": "null" Enable Cisco format including extra varbinds
}
}
Successful operation
Internal Error
Response Content-Types: application/json
L2VPN - Create
Create operation of resource: l2vpn
l2vpnbody object
Request Content-Types: application/json
Request Example
{ "vc-up": "null", Enable cpwVcUp notification
"vc-down": "null", Enable cpwVcDown notification
"enable": "null", Enable CISCO-IETF-PW-MIB notifications
"cisco": "null" Enable Cisco format including extra varbinds
}
}
Successful operation
Internal Error
Response Content-Types: application/json
L2VPN - Delete
Delete operation of resource: l2vpn
Successful operation
Internal Error
Response Content-Types: application/json
L2VPN - Retrieve
Retrieve operation of resource: l2vpn
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "vc-up": "null", Enable cpwVcUp notification
"vc-down": "null", Enable cpwVcDown notification
"enable": "null", Enable CISCO-IETF-PW-MIB notifications
"cisco": "null" Enable Cisco format including extra varbinds
}
}
OAM - Update
Update operation of resource: oam
oambody object
Successful operation
Internal Error
Response Content-Types: application/json
OAM - Create
Create operation of resource: oam
oambody object
Successful operation
Internal Error
Response Content-Types: application/json
OAM - Delete
Delete operation of resource: oam
Successful operation
Internal Error
Response Content-Types: application/json
OAM - Retrieve
Retrieve operation of resource: oam
Successful operation
Internal Error
CORRELATOR - Update
Update operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Ruleset name
}
]
}, { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
},
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Create
Create operation of resource: correlator
correlatorbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Ruleset name
}
]
}, { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
},
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Delete
Delete operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
CORRELATOR - Retrieve
Retrieve operation of resource: correlator
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Ruleset name
}
]
}, { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
},
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"
}
}
RULES - Update
Update operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Create
Create operation of resource: rules
rulesbody object
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Delete
Delete operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
RULES - Retrieve
Retrieve operation of resource: rules
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
}
]
}
}
RULE - Update
Update operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Create
Create operation of resource: rule
rulebody object
ID of name
Request Content-Types: application/json
Request Example
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Delete
Delete operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE - Retrieve
Retrieve operation of resource: rule
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}, "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}, { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
},
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
}
]
}
ROOT-CAUSES - Update
Update operation of resource: root-causes
root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Create
Create operation of resource: root-causes
root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Delete
Delete operation of resource: root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSES - Retrieve
Retrieve operation of resource: root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
}
ROOT-CAUSE - Update
Update operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Create
Create operation of resource: root-cause
root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Delete
Delete operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
ROOT-CAUSE - Retrieve
Retrieve operation of resource: root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of rootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
}
]
}
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
NON-ROOT-CAUSES - Update
Update operation of resource: non-root-causes
non-root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Create
Create operation of resource: non-root-causes
non-root-causesbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Delete
Delete operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSES - Retrieve
Retrieve operation of resource: non-root-causes
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
}
NON-ROOT-CAUSE - Update
Update operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Create
Create operation of resource: non-root-cause
non-root-causebody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Delete
Delete operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
NON-ROOT-CAUSE - Retrieve
Retrieve operation of resource: non-root-cause
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"oid": "string", OID of nonrootcause trap (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
},
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
}
]
}
VAR-BINDS - Update
Update operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Create
Create operation of resource: var-binds
var-bindsbody object
ID of name
ID of oid
Request Content-Types: application/json
Request Example
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Delete
Delete operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BINDS - Retrieve
Retrieve operation of resource: var-binds
ID of name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
}
VAR-BIND - Update
Update operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Create
Create operation of resource: var-bind
var-bindbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Delete
Delete operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
VAR-BIND - Retrieve
Retrieve operation of resource: var-bind
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"oid": "string", OID of varbind (dotted decimal) "index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
}
}
]
}
MATCH - Update
Update operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Create
Create operation of resource: match
matchbody object
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Delete
Delete operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
MATCH - Retrieve
Retrieve operation of resource: match
ID of name
ID of oid
ID of oid
Successful operation
Internal Error
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
RULE-SETS - Update
Update operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Create
Create operation of resource: rule-sets
rule-setsbody object
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Delete
Delete operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SETS - Retrieve
Retrieve operation of resource: rule-sets
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
}
RULE-SET - Update
Update operation of resource: rule-set
rule-setbody object
ID of name
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Create
Create operation of resource: rule-set
rule-setbody object
ID of name
Request Content-Types: application/json
Request Example
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Delete
Delete operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULE-SET - Retrieve
Retrieve operation of resource: rule-set
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
},
"name": "string", Ruleset name {
"rulename": "string" Rule name
}
]
}
}
]
}
RULENAMES - Update
Update operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Create
Create operation of resource: rulenames
rulenamesbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Delete
Delete operation of resource: rulenames
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
RULENAMES - Retrieve
Retrieve operation of resource: rulenames
ID of name
RULENAME - Update
Update operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Create
Create operation of resource: rulename
rulenamebody object
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Delete
Delete operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
Response Content-Types: application/json
RULENAME - Retrieve
Retrieve operation of resource: rulename
ID of name
ID of rulename
Successful operation
Internal Error
APPLIED-TO - Update
Update operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Create
Create operation of resource: applied-to
applied-tobody object
ID of name
Request Content-Types: application/json
Request Example
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Delete
Delete operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
APPLIED-TO - Retrieve
Retrieve operation of resource: applied-to
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "all": "null", Apply to all of the device {
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
}
]
}
}
}
HOSTS - Update
Update operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Create
Create operation of resource: hosts
hostsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Delete
Delete operation of resource: hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
HOSTS - Retrieve
Retrieve operation of resource: hosts
ID of name
Successful operation
Internal Error
HOST - Update
Update operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Create
Create operation of resource: host
hostbody object
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Delete
Delete operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
Response Content-Types: application/json
HOST - Retrieve
Retrieve operation of resource: host
ID of name
ID of ip-address port
Successful operation
Internal Error
BULK-STATS - Update
Update operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{ "memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte" {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" The name of the schema
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure schema name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}, {
"object-list-name": "string", Name of the object List {
"oid": "string" Object name or OID
}
]
},
"type": "null" Configure schema name
}
]
}, {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Create
Create operation of resource: bulk-stats
bulk-statsbody object
Request Content-Types: application/json
Request Example
{ "memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte" {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" The name of the schema
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure schema name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}, {
"object-list-name": "string", Name of the object List {
"oid": "string" Object name or OID
}
]
},
"type": "null" Configure schema name
}
]
}, {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Delete
Delete operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
BULK-STATS - Retrieve
Retrieve operation of resource: bulk-stats
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte" {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" The name of the schema
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure schema name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}, {
"object-list-name": "string", Name of the object List {
"oid": "string" Object name or OID
}
]
},
"type": "null" Configure schema name
}
]
}, {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
}
SCHEMAS - Update
Update operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Create
Create operation of resource: schemas
schemasbody object
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Delete
Delete operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMAS - Retrieve
Retrieve operation of resource: schemas
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
}
SCHEMA - Update
Update operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Create
Create operation of resource: schema
schemabody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Delete
Delete operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
SCHEMA - Retrieve
Retrieve operation of resource: schema
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"schema-name": "string", The name of the schema "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
}
]
}
INSTANCE - Update
Update operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Type of the instance
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Create
Create operation of resource: instance
instancebody object
ID of schema-name
Request Content-Types: application/json
Request Example
{ "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Type of the instance
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Delete
Delete operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
INSTANCE - Retrieve
Retrieve operation of resource: instance
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Type of the instance
}
}
OBJECTS - Update
Update operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
Successful operation
Internal Error
OBJECTS - Update
Update operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Create
Create operation of resource: objects
objectsbody object
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Delete
Delete operation of resource: objects
ID of object-list-name
Successful operation
Internal Error
Response Content-Types: application/json
OBJECTS - Retrieve
Retrieve operation of resource: objects
ID of object-list-name
OBJECT - Update
Update operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Create
Create operation of resource: object
objectbody object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Delete
Delete operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
Response Content-Types: application/json
OBJECT - Retrieve
Retrieve operation of resource: object
ID of object-list-name
ID of oid
Successful operation
Internal Error
TRANSFERS - Update
Update operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Create
Create operation of resource: transfers
transfersbody object
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Delete
Delete operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFERS - Retrieve
Retrieve operation of resource: transfers
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
}
TRANSFER - Update
Update operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Create
Create operation of resource: transfer
transferbody object
ID of transfer-name
Request Content-Types: application/json
Request Example
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Delete
Delete operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER - Retrieve
Retrieve operation of resource: transfer
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"retry": "integer", Number of transmission retries
range: "0..100" {
"schema-name": "string" Schema that contains objects to be\ncollected
}
]
},
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "minute"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
}
]
}
TRANSFER-SCHEMAS - Update
Update operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Create
Create operation of resource: transfer-schemas
transfer-schemasbody object
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Delete
Delete operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMAS - Retrieve
Retrieve operation of resource: transfer-schemas
ID of transfer-name
Successful operation
Internal Error
TRANSFER-SCHEMA - Update
Update operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Create
Create operation of resource: transfer-schema
transfer-schemabody object
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Delete
Delete operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
Response Content-Types: application/json
TRANSFER-SCHEMA - Retrieve
Retrieve operation of resource: transfer-schema
ID of transfer-name
ID of schema-name
Successful operation
Internal Error
DEFAULT-COMMUNITY-MAPS - Update
Update operation of resource: default-community-maps
default-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Create
Create operation of resource: default-community-maps
default-community-mapsbody object
Request Content-Types: application/json
Request Example
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Delete
Delete operation of resource: default-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAPS - Retrieve
Retrieve operation of resource: default-community-maps
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
}
]
}
}
DEFAULT-COMMUNITY-MAP - Update
Update operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Create
Create operation of resource: default-community-map
default-community-mapbody object
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Delete
Delete operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-COMMUNITY-MAP - Retrieve
Retrieve operation of resource: default-community-map
ID of community-name
Successful operation
Internal Error
OVERLOAD-CONTROL - Update
Update operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{ "drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Create
Create operation of resource: overload-control
overload-controlbody object
Request Content-Types: application/json
Request Example
{ "drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Delete
Delete operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
OVERLOAD-CONTROL - Retrieve
Retrieve operation of resource: overload-control
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"
}
}
TIMEOUTS - Update
Update operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{ "duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Create
Create operation of resource: timeouts
timeoutsbody object
Request Content-Types: application/json
Request Example
{ "duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Delete
Delete operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
TIMEOUTS - Retrieve
Retrieve operation of resource: timeouts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"
}
}
USERS - Update
Update operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Create
Create operation of resource: users
usersbody object
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Delete
Delete operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
USERS - Retrieve
Retrieve operation of resource: users
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
}
USER - Update
Update operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Create
Create operation of resource: user
userbody object
ID of user-name
Request Content-Types: application/json
Request Example
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
USER - Delete
Delete operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
USER - Retrieve
Retrieve operation of resource: user
ID of user-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
}
]
}
VRFS - Update
Update operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Create
Create operation of resource: vrfs
vrfsbody object
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Delete
Delete operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
VRFS - Retrieve
Retrieve operation of resource: vrfs
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
}
VRF - Update
Update operation of resource: vrf
vrfbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Create
Create operation of resource: vrf
vrfbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Delete
Delete operation of resource: vrf
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
VRF - Retrieve
Retrieve operation of resource: vrf
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"context-name": "string" Context Name
}
]
}, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
},
"name": "string", VRF name {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
]
}
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
ID of name
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of name
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of name
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of name
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of name
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
ID of name
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of name
ID of context-name
Successful operation
Internal Error
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of name
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of name
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
GROUPS - Update
Update operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Create
Create operation of resource: groups
groupsbody object
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Delete
Delete operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
GROUPS - Retrieve
Retrieve operation of resource: groups
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
}
GROUP - Update
Update operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Create
Create operation of resource: group
groupbody object
ID of name
Request Content-Types: application/json
Request Example
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Delete
Delete operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
GROUP - Retrieve
Retrieve operation of resource: group
ID of name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
}
]
}
TRAP-HOSTS - Update
Update operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Create
Create operation of resource: trap-hosts
trap-hostsbody object
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Delete
Delete operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOSTS - Retrieve
Retrieve operation of resource: trap-hosts
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
}
TRAP-HOST - Update
Update operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Create
Create operation of resource: trap-host
trap-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Delete
Delete operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
TRAP-HOST - Retrieve
Retrieve operation of resource: trap-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
},
"ip-address": "string", IP address of SNMP notification host {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
]
}
ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: encrypted-user-communities
encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: encrypted-user-community
encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-HOST - Update
Update operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Create
Create operation of resource: inform-host
inform-hostbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Delete
Delete operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-HOST - Retrieve
Retrieve operation of resource: inform-host
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
}
INFORM-USER-COMMUNITIES - Update
Update operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Create
Create operation of resource: inform-user-communities
inform-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Delete
Delete operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-USER-COMMUNITY - Update
Update operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Create
Create operation of resource: inform-user-community
inform-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Delete
Delete operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
INFORM-ENCRYPTED-USER-COMMUNITIES - Update
Update operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Create
Create operation of resource: inform-encrypted-user-communities
inform-encrypted-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Delete
Delete operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: inform-encrypted-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
INFORM-ENCRYPTED-USER-COMMUNITY - Update
Update operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Create
Create operation of resource: inform-encrypted-user-community
inform-encrypted-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Delete
Delete operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve
Retrieve operation of resource: inform-encrypted-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
DEFAULT-USER-COMMUNITIES - Update
Update operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Create
Create operation of resource: default-user-communities
default-user-communitiesbody object
ID of ip-address
Request Content-Types: application/json
Request Example
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Delete
Delete operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITIES - Retrieve
Retrieve operation of resource: default-user-communities
ID of ip-address
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
]
}
}
DEFAULT-USER-COMMUNITY - Update
Update operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Create
Create operation of resource: default-user-community
default-user-communitybody object
ID of ip-address
ID of community-name
Request Content-Types: application/json
Request Example
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Delete
Delete operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
DEFAULT-USER-COMMUNITY - Retrieve
Retrieve operation of resource: default-user-community
ID of ip-address
ID of community-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
}
}
CONTEXTS - Update
Update operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Create
Create operation of resource: contexts
contextsbody object
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Delete
Delete operation of resource: contexts
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXTS - Retrieve
Retrieve operation of resource: contexts
CONTEXT - Update
Update operation of resource: context
contextbody object
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Create
Create operation of resource: context
contextbody object
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Delete
Delete operation of resource: context
ID of context-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT - Retrieve
Retrieve operation of resource: context
ID of context-name
Successful operation
Internal Error
CONTEXT-MAPPINGS - Update
Update operation of resource: context-mappings
context-mappingsbody object
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Create
Create operation of resource: context-mappings
context-mappingsbody object
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Delete
Delete operation of resource: context-mappings
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPINGS - Retrieve
Retrieve operation of resource: context-mappings
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
}
CONTEXT-MAPPING - Update
Update operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Create
Create operation of resource: context-mapping
context-mappingbody object
ID of context-mapping-name
Request Content-Types: application/json
Request Example
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Delete
Delete operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
CONTEXT-MAPPING - Retrieve
Retrieve operation of resource: context-mapping
ID of context-mapping-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
}
]
}
MIB - Update
Update operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Create
Create operation of resource: mib
mibbody object
Request Content-Types: application/json
Request Example
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Delete
Delete operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
MIB - Retrieve
Retrieve operation of resource: mib
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
ETHERNET-FEATURES - Update
Update operation of resource: ethernet-features
ethernet-featuresbody object
Request Content-Types: application/json
Request Example
{ "egress-filtering-default-on": "null" Whether Egress Filtering is on by default
}, { "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"profile": "string", none
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"mode": "string", Possible required OAM modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs
"remote-loopback": "string", Enable or disable remote loopback\nrequirement
"session-up": "string", Action to perform when a session comes up
"link-fault": "string", Action to perform when a link fault message\nis received
"critical-event": "string", Action to perform when a critical event\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"session-down": "string" Action to perform when a session goes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement
"mode": "string", Possible required OAM modes
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement
},
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-FEATURES - Create
Create operation of resource: ethernet-features
ethernet-featuresbody object
Request Content-Types: application/json
Request Example
{ "egress-filtering-default-on": "null" Whether Egress Filtering is on by default
}, { "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"profile": "string", none
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"mode": "string", Possible required OAM modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs
"remote-loopback": "string", Enable or disable remote loopback\nrequirement
"session-up": "string", Action to perform when a session comes up
"link-fault": "string", Action to perform when a link fault message\nis received
"critical-event": "string", Action to perform when a critical event\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"session-down": "string" Action to perform when a session goes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement
"mode": "string", Possible required OAM modes
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement
},
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support
}
]
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-FEATURES - Delete
Delete operation of resource: ethernet-features
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-FEATURES - Retrieve
Retrieve operation of resource: ethernet-features
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "egress-filtering-default-on": "null" Whether Egress Filtering is on by default
}, { "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"profile": "string", none
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"mode": "string", Possible required OAM modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs
"remote-loopback": "string", Enable or disable remote loopback\nrequirement
"session-up": "string", Action to perform when a session comes up
"link-fault": "string", Action to perform when a link fault message\nis received
"critical-event": "string", Action to perform when a critical event\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"session-down": "string" Action to perform when a session goes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement
"mode": "string", Possible required OAM modes
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement
},
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support
}
]
}
}
}
}
EGRESS-FILTERING - Update
Update operation of resource: egress-filtering
egress-filteringbody object
Successful operation
Internal Error
Response Content-Types: application/json
EGRESS-FILTERING - Create
Create operation of resource: egress-filtering
egress-filteringbody object
Successful operation
Internal Error
Response Content-Types: application/json
EGRESS-FILTERING - Delete
Delete operation of resource: egress-filtering
Successful operation
Internal Error
Response Content-Types: application/json
EGRESS-FILTERING - Retrieve
Retrieve operation of resource: egress-filtering
Successful operation
Internal Error
ETHER-LINK-OAM - Update
Update operation of resource: ether-link-oam
ether-link-oambody object
Request Content-Types: application/json
Request Example
{ { "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"profile": "string", none
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"mode": "string", Possible required OAM modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs
"remote-loopback": "string", Enable or disable remote loopback\nrequirement
"session-up": "string", Action to perform when a session comes up
"link-fault": "string", Action to perform when a link fault message\nis received
"critical-event": "string", Action to perform when a critical event\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"session-down": "string" Action to perform when a session goes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement
"mode": "string", Possible required OAM modes
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement
},
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHER-LINK-OAM - Create
Create operation of resource: ether-link-oam
ether-link-oambody object
Request Content-Types: application/json
Request Example
{ { "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"profile": "string", none
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"mode": "string", Possible required OAM modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs
"remote-loopback": "string", Enable or disable remote loopback\nrequirement
"session-up": "string", Action to perform when a session comes up
"link-fault": "string", Action to perform when a link fault message\nis received
"critical-event": "string", Action to perform when a critical event\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"session-down": "string" Action to perform when a session goes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement
"mode": "string", Possible required OAM modes
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement
},
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support
}
]
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHER-LINK-OAM - Delete
Delete operation of resource: ether-link-oam
Successful operation
Internal Error
Response Content-Types: application/json
ETHER-LINK-OAM - Retrieve
Retrieve operation of resource: ether-link-oam
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"profile": "string", none
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"mode": "string", Possible required OAM modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs
"remote-loopback": "string", Enable or disable remote loopback\nrequirement
"session-up": "string", Action to perform when a session comes up
"link-fault": "string", Action to perform when a link fault message\nis received
"critical-event": "string", Action to perform when a critical event\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"session-down": "string" Action to perform when a session goes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement
"mode": "string", Possible required OAM modes
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement
},
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support
}
]
}
}
}
PROFILES - Update
Update operation of resource: profiles
profilesbody object
Request Content-Types: application/json
Request Example
{ { "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"profile": "string", none
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"mode": "string", Possible required OAM modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs
"remote-loopback": "string", Enable or disable remote loopback\nrequirement
"session-up": "string", Action to perform when a session comes up
"link-fault": "string", Action to perform when a link fault message\nis received
"critical-event": "string", Action to perform when a critical event\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"session-down": "string" Action to perform when a session goes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement
"mode": "string", Possible required OAM modes
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement
},
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILES - Create
Create operation of resource: profiles
profilesbody object
Request Content-Types: application/json
Request Example
{ { "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"profile": "string", none
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"mode": "string", Possible required OAM modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs
"remote-loopback": "string", Enable or disable remote loopback\nrequirement
"session-up": "string", Action to perform when a session comes up
"link-fault": "string", Action to perform when a link fault message\nis received
"critical-event": "string", Action to perform when a critical event\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"session-down": "string" Action to perform when a session goes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement
"mode": "string", Possible required OAM modes
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement
},
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILES - Delete
Delete operation of resource: profiles
Successful operation
Internal Error
Response Content-Types: application/json
PROFILES - Retrieve
Retrieve operation of resource: profiles
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"profile": "string", none
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"mode": "string", Possible required OAM modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs
"remote-loopback": "string", Enable or disable remote loopback\nrequirement
"session-up": "string", Action to perform when a session comes up
"link-fault": "string", Action to perform when a link fault message\nis received
"critical-event": "string", Action to perform when a critical event\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"session-down": "string" Action to perform when a session goes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement
"mode": "string", Possible required OAM modes
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement
},
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support
}
]
}
}
PROFILE - Update
Update operation of resource: profile
profilebody object
ID of profile
Request Content-Types: application/json
Request Example
{ { "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"profile": "string", none
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"mode": "string", Possible required OAM modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs
"remote-loopback": "string", Enable or disable remote loopback\nrequirement
"session-up": "string", Action to perform when a session comes up
"link-fault": "string", Action to perform when a link fault message\nis received
"critical-event": "string", Action to perform when a critical event\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"session-down": "string" Action to perform when a session goes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement
"mode": "string", Possible required OAM modes
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement
},
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Create
Create operation of resource: profile
profilebody object
ID of profile
Request Content-Types: application/json
Request Example
{ { "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"profile": "string", none
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"mode": "string", Possible required OAM modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs
"remote-loopback": "string", Enable or disable remote loopback\nrequirement
"session-up": "string", Action to perform when a session comes up
"link-fault": "string", Action to perform when a link fault message\nis received
"critical-event": "string", Action to perform when a critical event\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"session-down": "string" Action to perform when a session goes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement
"mode": "string", Possible required OAM modes
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement
},
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Delete
Delete operation of resource: profile
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
PROFILE - Retrieve
Retrieve operation of resource: profile
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ { "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"profile": "string", none
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"mode": "string", Possible required OAM modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs
"remote-loopback": "string", Enable or disable remote loopback\nrequirement
"session-up": "string", Action to perform when a session comes up
"link-fault": "string", Action to perform when a link fault message\nis received
"critical-event": "string", Action to perform when a critical event\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"session-down": "string" Action to perform when a session goes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement
"mode": "string", Possible required OAM modes
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement
},
"udlf": "boolean" Enable or disable uni-directional link-fault\ndetection support
}
]
}
ACTION - Update
Update operation of resource: action
actionbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs
"remote-loopback": "string", Action to perform when remote loopback is\nentered or exited
"session-up": "string", Action to perform when a session comes up
"link-fault": "string", Action to perform when a link fault message\nis received
"critical-event": "string", Action to perform when a critical event\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"session-down": "string" Action to perform when a session goes down
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION - Create
Create operation of resource: action
actionbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs
"remote-loopback": "string", Action to perform when remote loopback is\nentered or exited
"session-up": "string", Action to perform when a session comes up
"link-fault": "string", Action to perform when a link fault message\nis received
"critical-event": "string", Action to perform when a critical event\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"session-down": "string" Action to perform when a session goes down
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION - Delete
Delete operation of resource: action
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
ACTION - Retrieve
Retrieve operation of resource: action
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities\nconflict occurs
"remote-loopback": "string", Action to perform when remote loopback is\nentered or exited
"session-up": "string", Action to perform when a session comes up
"link-fault": "string", Action to perform when a link fault message\nis received
"critical-event": "string", Action to perform when a critical event\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"high-threshold": "string", Action to perform when a high-threshold\nevent occurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"session-down": "string" Action to perform when a session goes down
}
}
REQUIRE-REMOTE - Update
Update operation of resource: require-remote
require-remotebody object
ID of profile
Request Content-Types: application/json
Request Example
{ "mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement
"mode": "string", Possible required OAM modes
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REQUIRE-REMOTE - Create
Create operation of resource: require-remote
require-remotebody object
ID of profile
Request Content-Types: application/json
Request Example
{ "mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement
"mode": "string", Possible required OAM modes
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REQUIRE-REMOTE - Delete
Delete operation of resource: require-remote
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
REQUIRE-REMOTE - Retrieve
Retrieve operation of resource: require-remote
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "mib-retrieval": "boolean", Enable or disable MIB retrieval requirement
"link-monitoring": "boolean", Enable or disable link monitoring\nrequirement
"mode": "string", Possible required OAM modes
"remote-loopback": "boolean" Enable or disable remote loopback\nrequirement
}
}
LINK-MONITORING - Update
Update operation of resource: link-monitoring
link-monitoringbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-MONITORING - Create
Create operation of resource: link-monitoring
link-monitoringbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-MONITORING - Delete
Delete operation of resource: link-monitoring
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
LINK-MONITORING - Retrieve
Retrieve operation of resource: link-monitoring
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
}
}
SYMBOL-PERIOD - Update
Update operation of resource: symbol-period
symbol-periodbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for symbol-period
range: "1..4294967295"
units: "second"
"units": "string", Units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for symbol-period
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)
}, "units": "string", Units to use for this window
"window": "integer", Size of the symbol-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Symbols and treated as 1\nif unspecified)
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYMBOL-PERIOD - Create
Create operation of resource: symbol-period
symbol-periodbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for symbol-period
range: "1..4294967295"
units: "second"
"units": "string", Units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for symbol-period
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)
}, "units": "string", Units to use for this window
"window": "integer", Size of the symbol-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Symbols and treated as 1\nif unspecified)
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYMBOL-PERIOD - Delete
Delete operation of resource: symbol-period
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
SYMBOL-PERIOD - Retrieve
Retrieve operation of resource: symbol-period
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for symbol-period
range: "1..4294967295"
units: "second"
"units": "string", Units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for symbol-period
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)
}, "units": "string", Units to use for this window
"window": "integer", Size of the symbol-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Symbols and treated as 1\nif unspecified)
}
}
}
WINDOW - Update
Update operation of resource: window
windowbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Create
Create operation of resource: window
windowbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Delete
Delete operation of resource: window
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Retrieve
Retrieve operation of resource: window
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
FRAME-PERIOD - Update
Update operation of resource: frame-period
frame-periodbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-PERIOD - Create
Create operation of resource: frame-period
frame-periodbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-PERIOD - Delete
Delete operation of resource: frame-period
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-PERIOD - Retrieve
Retrieve operation of resource: frame-period
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
}
WINDOW - Update
Update operation of resource: window
windowbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Create
Create operation of resource: window
windowbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Delete
Delete operation of resource: window
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Retrieve
Retrieve operation of resource: window
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
FRAME-SECONDS - Update
Update operation of resource: frame-seconds
frame-secondsbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-SECONDS - Create
Create operation of resource: frame-seconds
frame-secondsbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-SECONDS - Delete
Delete operation of resource: frame-seconds
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-SECONDS - Retrieve
Retrieve operation of resource: frame-seconds
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"
}
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
FRAME - Update
Update operation of resource: frame
framebody object
ID of profile
Request Content-Types: application/json
Request Example
{ : {Threshold configuration for frame-seconds\nevents "threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME - Create
Create operation of resource: frame
framebody object
ID of profile
Request Content-Types: application/json
Request Example
{ : {Threshold configuration for frame-seconds\nevents "threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME - Delete
Delete operation of resource: frame
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
FRAME - Retrieve
Retrieve operation of resource: frame
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {Threshold configuration for frame-seconds\nevents "threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of profile
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of profile
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
GLOBAL-INTERFACE-CONFIGURATION - Update
Update operation of resource: global-interface-configuration
global-interface-configurationbody object
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-INTERFACE-CONFIGURATION - Create
Create operation of resource: global-interface-configuration
global-interface-configurationbody object
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-INTERFACE-CONFIGURATION - Delete
Delete operation of resource: global-interface-configuration
Successful operation
Internal Error
Response Content-Types: application/json
GLOBAL-INTERFACE-CONFIGURATION - Retrieve
Retrieve operation of resource: global-interface-configuration
Successful operation
Internal Error
INTERFACE-CONFIGURATIONS - Update
Update operation of resource: interface-configurations
interface-configurationsbody object
Request Content-Types: application/json
Request Example
{ {
"interface-mode-non-physical": "string", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software subinterface.
"description": "string", The description of this interface
"interface-virtual": "null", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software virtual/subinterface. "ingress": "null", Per MAC address accounting statistics
"egress": "null" Per MAC address accounting statistics
},
"bandwidth": "integer", The bandwidth of the interface in kbps
range: "0..4294967295"
units: "kbit/s" "ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"mode": "string", How to handle the protocol's packets
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement
"session-up": "string", Action to perform when a session comes up
"critical-event": "string", Action to perform when a critical event occurs
"link-fault": "string", Action to perform when a link fault occurs
"high-threshold": "string", Action to perform when a high-threshold event\noccurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"session-down": "string" Action to perform when a session comes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement
"mode": "string", How to handle the protocol's packets
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement
},
"profile-name": "string" Set the profile to use on the interface
},
"filtering": "string" Ingress Ethernet frame filtering
},
"shutdown": "null", The existence of this configuration indicates\nthe interface is shut down "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"vlan-identifier": "string" The VLAN tag stack associated with this\nsub-interface.
},
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100
},
"active": "string", Whether the interface is active or\npreconfigured "encapsulation": "string", The encapsulation of this Ethernet service
"capsulation-options": "integer" The options for this capsulation, usually '0'
}, "host-routing": "null" Enable host-routing on this BVI
}, "carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0
}, "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"first-tag": "string", First (outermost) VLAN tag value
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces
}
}, "propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state {
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop
"l2-protocol-name": "string", Protocol name
"mode": "string" How to handle the protocol's packets
}
]
},
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved. "egress-filtering": "string", Egress Ethernet filtering
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter
}
}, "generic-interface-list": "string", Name of the interface list
"l2-overhead": "integer" PW Ether L2 overhead requirement
}, "args": "string", Dampening Arguments
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"
"restart-penalty": "integer" Restart penalty
range: "0..20000"
},
"interface-name": "string", The name of the interface
"secondary-admin-state": "string", The secondary admin state of the interface "outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"outer-vlan-id": "string", VLAN id for outer tag
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag
}, "inner-tag-value": "string", VLAN Id of innermost tag to be pushed
"rewrite-type": "string", The type of rewrite to perform
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed
"inner-tag-type": "string", Type of tag for inner match (if present)
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
}, "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}, "l2-overhead": "integer", PW Ether L2 overhead requirement
"generic-interface-list": "string" Name of the interface list
},
"link-status": "null", Enable interface and line-protocol state change\nalarms {
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'
"mtu": "integer" The MTU value
range: "64..65535"
}
]
}, "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATIONS - Create
Create operation of resource: interface-configurations
interface-configurationsbody object
Request Content-Types: application/json
Request Example
{ {
"interface-mode-non-physical": "string", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software subinterface.
"description": "string", The description of this interface
"interface-virtual": "null", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software virtual/subinterface. "ingress": "null", Per MAC address accounting statistics
"egress": "null" Per MAC address accounting statistics
},
"bandwidth": "integer", The bandwidth of the interface in kbps
range: "0..4294967295"
units: "kbit/s" "ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"mode": "string", How to handle the protocol's packets
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement
"session-up": "string", Action to perform when a session comes up
"critical-event": "string", Action to perform when a critical event occurs
"link-fault": "string", Action to perform when a link fault occurs
"high-threshold": "string", Action to perform when a high-threshold event\noccurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"session-down": "string" Action to perform when a session comes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement
"mode": "string", How to handle the protocol's packets
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement
},
"profile-name": "string" Set the profile to use on the interface
},
"filtering": "string" Ingress Ethernet frame filtering
},
"shutdown": "null", The existence of this configuration indicates\nthe interface is shut down "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"vlan-identifier": "string" The VLAN tag stack associated with this\nsub-interface.
},
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100
},
"active": "string", Whether the interface is active or\npreconfigured "encapsulation": "string", The encapsulation of this Ethernet service
"capsulation-options": "integer" The options for this capsulation, usually '0'
}, "host-routing": "null" Enable host-routing on this BVI
}, "carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0
}, "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"first-tag": "string", First (outermost) VLAN tag value
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces
}
}, "propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state {
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop
"l2-protocol-name": "string", Protocol name
"mode": "string" How to handle the protocol's packets
}
]
},
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved. "egress-filtering": "string", Egress Ethernet filtering
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter
}
}, "generic-interface-list": "string", Name of the interface list
"l2-overhead": "integer" PW Ether L2 overhead requirement
}, "args": "string", Dampening Arguments
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"
"restart-penalty": "integer" Restart penalty
range: "0..20000"
},
"interface-name": "string", The name of the interface
"secondary-admin-state": "string", The secondary admin state of the interface "outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"outer-vlan-id": "string", VLAN id for outer tag
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag
}, "inner-tag-value": "string", VLAN Id of innermost tag to be pushed
"rewrite-type": "string", The type of rewrite to perform
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed
"inner-tag-type": "string", Type of tag for inner match (if present)
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
}, "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}, "l2-overhead": "integer", PW Ether L2 overhead requirement
"generic-interface-list": "string" Name of the interface list
},
"link-status": "null", Enable interface and line-protocol state change\nalarms {
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'
"mtu": "integer" The MTU value
range: "64..65535"
}
]
}, "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATIONS - Delete
Delete operation of resource: interface-configurations
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATIONS - Retrieve
Retrieve operation of resource: interface-configurations
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-mode-non-physical": "string", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software subinterface.
"description": "string", The description of this interface
"interface-virtual": "null", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software virtual/subinterface. "ingress": "null", Per MAC address accounting statistics
"egress": "null" Per MAC address accounting statistics
},
"bandwidth": "integer", The bandwidth of the interface in kbps
range: "0..4294967295"
units: "kbit/s" "ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"mode": "string", How to handle the protocol's packets
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement
"session-up": "string", Action to perform when a session comes up
"critical-event": "string", Action to perform when a critical event occurs
"link-fault": "string", Action to perform when a link fault occurs
"high-threshold": "string", Action to perform when a high-threshold event\noccurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"session-down": "string" Action to perform when a session comes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement
"mode": "string", How to handle the protocol's packets
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement
},
"profile-name": "string" Set the profile to use on the interface
},
"filtering": "string" Ingress Ethernet frame filtering
},
"shutdown": "null", The existence of this configuration indicates\nthe interface is shut down "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"vlan-identifier": "string" The VLAN tag stack associated with this\nsub-interface.
},
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100
},
"active": "string", Whether the interface is active or\npreconfigured "encapsulation": "string", The encapsulation of this Ethernet service
"capsulation-options": "integer" The options for this capsulation, usually '0'
}, "host-routing": "null" Enable host-routing on this BVI
}, "carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0
}, "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"first-tag": "string", First (outermost) VLAN tag value
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces
}
}, "propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state {
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop
"l2-protocol-name": "string", Protocol name
"mode": "string" How to handle the protocol's packets
}
]
},
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved. "egress-filtering": "string", Egress Ethernet filtering
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter
}
}, "generic-interface-list": "string", Name of the interface list
"l2-overhead": "integer" PW Ether L2 overhead requirement
}, "args": "string", Dampening Arguments
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"
"restart-penalty": "integer" Restart penalty
range: "0..20000"
},
"interface-name": "string", The name of the interface
"secondary-admin-state": "string", The secondary admin state of the interface "outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"outer-vlan-id": "string", VLAN id for outer tag
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag
}, "inner-tag-value": "string", VLAN Id of innermost tag to be pushed
"rewrite-type": "string", The type of rewrite to perform
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed
"inner-tag-type": "string", Type of tag for inner match (if present)
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
}, "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}, "l2-overhead": "integer", PW Ether L2 overhead requirement
"generic-interface-list": "string" Name of the interface list
},
"link-status": "null", Enable interface and line-protocol state change\nalarms {
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'
"mtu": "integer" The MTU value
range: "64..65535"
}
]
}, "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
}
]
}
}
INTERFACE-CONFIGURATION - Update
Update operation of resource: interface-configuration
interface-configurationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-mode-non-physical": "string", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software subinterface.
"description": "string", The description of this interface
"interface-virtual": "null", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software virtual/subinterface. "ingress": "null", Per MAC address accounting statistics
"egress": "null" Per MAC address accounting statistics
},
"bandwidth": "integer", The bandwidth of the interface in kbps
range: "0..4294967295"
units: "kbit/s" "ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"mode": "string", How to handle the protocol's packets
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement
"session-up": "string", Action to perform when a session comes up
"critical-event": "string", Action to perform when a critical event occurs
"link-fault": "string", Action to perform when a link fault occurs
"high-threshold": "string", Action to perform when a high-threshold event\noccurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"session-down": "string" Action to perform when a session comes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement
"mode": "string", How to handle the protocol's packets
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement
},
"profile-name": "string" Set the profile to use on the interface
},
"filtering": "string" Ingress Ethernet frame filtering
},
"shutdown": "null", The existence of this configuration indicates\nthe interface is shut down "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"vlan-identifier": "string" The VLAN tag stack associated with this\nsub-interface.
},
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100
},
"active": "string", Whether the interface is active or\npreconfigured "encapsulation": "string", The encapsulation of this Ethernet service
"capsulation-options": "integer" The options for this capsulation, usually '0'
}, "host-routing": "null" Enable host-routing on this BVI
}, "carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0
}, "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"first-tag": "string", First (outermost) VLAN tag value
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces
}
}, "propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state {
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop
"l2-protocol-name": "string", Protocol name
"mode": "string" How to handle the protocol's packets
}
]
},
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved. "egress-filtering": "string", Egress Ethernet filtering
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter
}
}, "generic-interface-list": "string", Name of the interface list
"l2-overhead": "integer" PW Ether L2 overhead requirement
}, "args": "string", Dampening Arguments
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"
"restart-penalty": "integer" Restart penalty
range: "0..20000"
},
"interface-name": "string", The name of the interface
"secondary-admin-state": "string", The secondary admin state of the interface "outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"outer-vlan-id": "string", VLAN id for outer tag
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag
}, "inner-tag-value": "string", VLAN Id of innermost tag to be pushed
"rewrite-type": "string", The type of rewrite to perform
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed
"inner-tag-type": "string", Type of tag for inner match (if present)
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
}, "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}, "l2-overhead": "integer", PW Ether L2 overhead requirement
"generic-interface-list": "string" Name of the interface list
},
"link-status": "null", Enable interface and line-protocol state change\nalarms {
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'
"mtu": "integer" The MTU value
range: "64..65535"
}
]
}, "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATION - Create
Create operation of resource: interface-configuration
interface-configurationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ {
"interface-mode-non-physical": "string", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software subinterface.
"description": "string", The description of this interface
"interface-virtual": "null", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software virtual/subinterface. "ingress": "null", Per MAC address accounting statistics
"egress": "null" Per MAC address accounting statistics
},
"bandwidth": "integer", The bandwidth of the interface in kbps
range: "0..4294967295"
units: "kbit/s" "ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"mode": "string", How to handle the protocol's packets
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement
"session-up": "string", Action to perform when a session comes up
"critical-event": "string", Action to perform when a critical event occurs
"link-fault": "string", Action to perform when a link fault occurs
"high-threshold": "string", Action to perform when a high-threshold event\noccurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"session-down": "string" Action to perform when a session comes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement
"mode": "string", How to handle the protocol's packets
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement
},
"profile-name": "string" Set the profile to use on the interface
},
"filtering": "string" Ingress Ethernet frame filtering
},
"shutdown": "null", The existence of this configuration indicates\nthe interface is shut down "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"vlan-identifier": "string" The VLAN tag stack associated with this\nsub-interface.
},
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100
},
"active": "string", Whether the interface is active or\npreconfigured "encapsulation": "string", The encapsulation of this Ethernet service
"capsulation-options": "integer" The options for this capsulation, usually '0'
}, "host-routing": "null" Enable host-routing on this BVI
}, "carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0
}, "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"first-tag": "string", First (outermost) VLAN tag value
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces
}
}, "propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state {
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop
"l2-protocol-name": "string", Protocol name
"mode": "string" How to handle the protocol's packets
}
]
},
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved. "egress-filtering": "string", Egress Ethernet filtering
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter
}
}, "generic-interface-list": "string", Name of the interface list
"l2-overhead": "integer" PW Ether L2 overhead requirement
}, "args": "string", Dampening Arguments
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"
"restart-penalty": "integer" Restart penalty
range: "0..20000"
},
"interface-name": "string", The name of the interface
"secondary-admin-state": "string", The secondary admin state of the interface "outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"outer-vlan-id": "string", VLAN id for outer tag
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag
}, "inner-tag-value": "string", VLAN Id of innermost tag to be pushed
"rewrite-type": "string", The type of rewrite to perform
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed
"inner-tag-type": "string", Type of tag for inner match (if present)
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
}, "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}, "l2-overhead": "integer", PW Ether L2 overhead requirement
"generic-interface-list": "string" Name of the interface list
},
"link-status": "null", Enable interface and line-protocol state change\nalarms {
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'
"mtu": "integer" The MTU value
range: "64..65535"
}
]
}, "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATION - Delete
Delete operation of resource: interface-configuration
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
INTERFACE-CONFIGURATION - Retrieve
Retrieve operation of resource: interface-configuration
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"interface-mode-non-physical": "string", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software subinterface.
"description": "string", The description of this interface
"interface-virtual": "null", The mode in which an interface is running. The\nexistence of this object causes the creation of\nthe software virtual/subinterface. "ingress": "null", Per MAC address accounting statistics
"egress": "null" Per MAC address accounting statistics
},
"bandwidth": "integer", The bandwidth of the interface in kbps
range: "0..4294967295"
units: "kbit/s" "ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"mode": "string", How to handle the protocol's packets
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement
"session-up": "string", Action to perform when a session comes up
"critical-event": "string", Action to perform when a critical event occurs
"link-fault": "string", Action to perform when a link fault occurs
"high-threshold": "string", Action to perform when a high-threshold event\noccurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"session-down": "string" Action to perform when a session comes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement
"mode": "string", How to handle the protocol's packets
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement
},
"profile-name": "string" Set the profile to use on the interface
},
"filtering": "string" Ingress Ethernet frame filtering
},
"shutdown": "null", The existence of this configuration indicates\nthe interface is shut down "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"vlan-identifier": "string" The VLAN tag stack associated with this\nsub-interface.
},
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100
},
"active": "string", Whether the interface is active or\npreconfigured "encapsulation": "string", The encapsulation of this Ethernet service
"capsulation-options": "integer" The options for this capsulation, usually '0'
}, "host-routing": "null" Enable host-routing on this BVI
}, "carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0
}, "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"first-tag": "string", First (outermost) VLAN tag value
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces
}
}, "propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state {
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop
"l2-protocol-name": "string", Protocol name
"mode": "string" How to handle the protocol's packets
}
]
},
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved. "egress-filtering": "string", Egress Ethernet filtering
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter
}
}, "generic-interface-list": "string", Name of the interface list
"l2-overhead": "integer" PW Ether L2 overhead requirement
}, "args": "string", Dampening Arguments
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"
"restart-penalty": "integer" Restart penalty
range: "0..20000"
},
"interface-name": "string", The name of the interface
"secondary-admin-state": "string", The secondary admin state of the interface "outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"outer-vlan-id": "string", VLAN id for outer tag
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag
}, "inner-tag-value": "string", VLAN Id of innermost tag to be pushed
"rewrite-type": "string", The type of rewrite to perform
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed
"inner-tag-type": "string", Type of tag for inner match (if present)
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
}, "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}, "l2-overhead": "integer", PW Ether L2 overhead requirement
"generic-interface-list": "string" Name of the interface list
},
"link-status": "null", Enable interface and line-protocol state change\nalarms {
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'
"mtu": "integer" The MTU value
range: "64..65535"
}
]
}, "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
}
]
}
DAMPENING - Update
Update operation of resource: dampening
dampeningbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "args": "string", Dampening Arguments
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"
"restart-penalty": "integer" Restart penalty
range: "0..20000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DAMPENING - Create
Create operation of resource: dampening
dampeningbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "args": "string", Dampening Arguments
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"
"restart-penalty": "integer" Restart penalty
range: "0..20000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
DAMPENING - Delete
Delete operation of resource: dampening
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
DAMPENING - Retrieve
Retrieve operation of resource: dampening
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "args": "string", Dampening Arguments
"suppress-threshold": "integer", Suppress threshold
range: "1..20000"
"half-life": "integer", Decay half life (in minutes)
range: "1..45"
units: "minute"
"suppress-time": "integer", Max suppress time (in minutes)
range: "1..255"
units: "minute"
"reuse-threshold": "integer", Reuse threshold
range: "1..20000"
"restart-penalty": "integer" Restart penalty
range: "0..20000"
}
}
MTUS - Update
Update operation of resource: mtus
mtusbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ {
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'
"mtu": "integer" The MTU value
range: "64..65535"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MTUS - Create
Create operation of resource: mtus
mtusbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ {
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'
"mtu": "integer" The MTU value
range: "64..65535"
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
MTUS - Delete
Delete operation of resource: mtus
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MTUS - Retrieve
Retrieve operation of resource: mtus
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"owner": "string", The Owner of the interface - eg. for\n'LoopbackX' main interface this is 'loopback'
"mtu": "integer" The MTU value
range: "64..65535"
}
]
}
}
MTU - Update
Update operation of resource: mtu
mtubody object
ID of active interface-name
ID of owner
Successful operation
Internal Error
Response Content-Types: application/json
MTU - Create
Create operation of resource: mtu
mtubody object
ID of active interface-name
ID of owner
Successful operation
Internal Error
Response Content-Types: application/json
MTU - Delete
Delete operation of resource: mtu
ID of active interface-name
ID of owner
Successful operation
Internal Error
Response Content-Types: application/json
MTU - Retrieve
Retrieve operation of resource: mtu
ID of active interface-name
ID of owner
Successful operation
Internal Error
ENCAPSULATION - Update
Update operation of resource: encapsulation
encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCAPSULATION - Create
Create operation of resource: encapsulation
encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCAPSULATION - Delete
Delete operation of resource: encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCAPSULATION - Retrieve
Retrieve operation of resource: encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
PSEUDOWIRE-ETHER - Update
Update operation of resource: pseudowire-ether
pseudowire-etherbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE-ETHER - Create
Create operation of resource: pseudowire-ether
pseudowire-etherbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE-ETHER - Delete
Delete operation of resource: pseudowire-ether
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE-ETHER - Retrieve
Retrieve operation of resource: pseudowire-ether
ID of active interface-name
Successful operation
Internal Error
PSEUDOWIRE-IW - Update
Update operation of resource: pseudowire-iw
pseudowire-iwbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE-IW - Create
Create operation of resource: pseudowire-iw
pseudowire-iwbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE-IW - Delete
Delete operation of resource: pseudowire-iw
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
PSEUDOWIRE-IW - Retrieve
Retrieve operation of resource: pseudowire-iw
ID of active interface-name
Successful operation
Internal Error
BVI - Update
Update operation of resource: bvi
bvibody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BVI - Create
Create operation of resource: bvi
bvibody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BVI - Delete
Delete operation of resource: bvi
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
BVI - Retrieve
Retrieve operation of resource: bvi
ID of active interface-name
Successful operation
Internal Error
L2-TRANSPORT - Update
Update operation of resource: l2-transport
l2-transportbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state {
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop
"l2-protocol-name": "string", Protocol name
"mode": "string" How to handle the protocol's packets
}
]
},
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved. "egress-filtering": "string", Egress Ethernet filtering
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
L2-TRANSPORT - Create
Create operation of resource: l2-transport
l2-transportbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state {
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop
"l2-protocol-name": "string", Protocol name
"mode": "string" How to handle the protocol's packets
}
]
},
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved. "egress-filtering": "string", Egress Ethernet filtering
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
L2-TRANSPORT - Delete
Delete operation of resource: l2-transport
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
L2-TRANSPORT - Retrieve
Retrieve operation of resource: l2-transport
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "propagate-remote-status": "null", Enable propagation of the remote\nattachment-circuit link state to the\nlocalattachment-circuit link state {
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop
"l2-protocol-name": "string", Protocol name
"mode": "string" How to handle the protocol's packets
}
]
},
"enabled": "null", This object is only valid on physical\ninterfaces and it controls whether that\ninterface is a port mode Layer 2 attachment\ncircuit (note that for subinterfaces, the Layer\n2 property is specified when the subinterface\nis created).The object must be set before any\nother L2Transport configuration is supplied for\nthe interface, and must be the last\nper-interface configuration object to be\nremoved. "egress-filtering": "string", Egress Ethernet filtering
"source-bypass-egress-filtering": "null" Mark all ingress packets to bypass any egress\nVLAN filter
}
}
}
L2-PROTOCOLS - Update
Update operation of resource: l2-protocols
l2-protocolsbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ {
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop
"l2-protocol-name": "string", Protocol name
"mode": "string" How to handle the protocol's packets
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
L2-PROTOCOLS - Create
Create operation of resource: l2-protocols
l2-protocolsbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ {
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop
"l2-protocol-name": "string", Protocol name
"mode": "string" How to handle the protocol's packets
}
]
}
}
Successful operation
Internal Error
Response Content-Types: application/json
L2-PROTOCOLS - Delete
Delete operation of resource: l2-protocols
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
L2-PROTOCOLS - Retrieve
Retrieve operation of resource: l2-protocols
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop
"l2-protocol-name": "string", Protocol name
"mode": "string" How to handle the protocol's packets
}
]
}
}
L2-PROTOCOL - Update
Update operation of resource: l2-protocol
l2-protocolbody object
ID of active interface-name
ID of l2-protocol-name
Request Content-Types: application/json
Request Example
{ {
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop
"l2-protocol-name": "string", Protocol name
"mode": "string" How to handle the protocol's packets
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
L2-PROTOCOL - Create
Create operation of resource: l2-protocol
l2-protocolbody object
ID of active interface-name
ID of l2-protocol-name
Request Content-Types: application/json
Request Example
{ {
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop
"l2-protocol-name": "string", Protocol name
"mode": "string" How to handle the protocol's packets
}
]
}
Successful operation
Internal Error
Response Content-Types: application/json
L2-PROTOCOL - Delete
Delete operation of resource: l2-protocol
ID of active interface-name
ID of l2-protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
L2-PROTOCOL - Retrieve
Retrieve operation of resource: l2-protocol
ID of active interface-name
ID of l2-protocol-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ {
"mpls-exp-bits-value": "string", The value to set the MPLS Exp bits to within\nthe PW.This value may be specified if the mode\nis forward or tunnel and must not be specified\nif the mode is drop
"l2-protocol-name": "string", Protocol name
"mode": "string" How to handle the protocol's packets
}
]
}
L2-ETHERNET-FEATURES - Update
Update operation of resource: l2-ethernet-features
l2-ethernet-featuresbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
L2-ETHERNET-FEATURES - Create
Create operation of resource: l2-ethernet-features
l2-ethernet-featuresbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
L2-ETHERNET-FEATURES - Delete
Delete operation of resource: l2-ethernet-features
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
L2-ETHERNET-FEATURES - Retrieve
Retrieve operation of resource: l2-ethernet-features
ID of active interface-name
Successful operation
Internal Error
VLAN-SUB-CONFIGURATION - Update
Update operation of resource: vlan-sub-configuration
vlan-sub-configurationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"first-tag": "string", First (outermost) VLAN tag value
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-SUB-CONFIGURATION - Create
Create operation of resource: vlan-sub-configuration
vlan-sub-configurationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"first-tag": "string", First (outermost) VLAN tag value
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-SUB-CONFIGURATION - Delete
Delete operation of resource: vlan-sub-configuration
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-SUB-CONFIGURATION - Retrieve
Retrieve operation of resource: vlan-sub-configuration
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"first-tag": "string", First (outermost) VLAN tag value
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces
}
}
}
VLAN-IDENTIFIER - Update
Update operation of resource: vlan-identifier
vlan-identifierbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"first-tag": "string", First (outermost) VLAN tag value
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-IDENTIFIER - Create
Create operation of resource: vlan-identifier
vlan-identifierbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"first-tag": "string", First (outermost) VLAN tag value
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-IDENTIFIER - Delete
Delete operation of resource: vlan-identifier
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-IDENTIFIER - Retrieve
Retrieve operation of resource: vlan-identifier
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "vlan-type": "string", Whether this sub-interface is dot1ad or dot1Q
"first-tag": "string", First (outermost) VLAN tag value
"second-tag": "string" Second VLAN tag value. The any value may only\nbe used for Layer 2 subinterfaces
}
}
ETHERNET-SERVICE - Update
Update operation of resource: ethernet-service
ethernet-servicebody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"outer-vlan-id": "string", VLAN id for outer tag
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag
}, "inner-tag-value": "string", VLAN Id of innermost tag to be pushed
"rewrite-type": "string", The type of rewrite to perform
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed
"inner-tag-type": "string", Type of tag for inner match (if present)
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
}, "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-SERVICE - Create
Create operation of resource: ethernet-service
ethernet-servicebody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"outer-vlan-id": "string", VLAN id for outer tag
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag
}, "inner-tag-value": "string", VLAN Id of innermost tag to be pushed
"rewrite-type": "string", The type of rewrite to perform
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed
"inner-tag-type": "string", Type of tag for inner match (if present)
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
}, "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-SERVICE - Delete
Delete operation of resource: ethernet-service
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-SERVICE - Retrieve
Retrieve operation of resource: ethernet-service
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"outer-vlan-id": "string", VLAN id for outer tag
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag
}, "inner-tag-value": "string", VLAN Id of innermost tag to be pushed
"rewrite-type": "string", The type of rewrite to perform
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed
"inner-tag-type": "string", Type of tag for inner match (if present)
"outer-tag-type": "string" Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
}, "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
}
LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Update
Update operation of resource: local-traffic-default-encapsulation
local-traffic-default-encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "outer-tag-type": "string", Type of outer tag
"outer-vlan-id": "string", VLAN id for outer tag
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Create
Create operation of resource: local-traffic-default-encapsulation
local-traffic-default-encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "outer-tag-type": "string", Type of outer tag
"outer-vlan-id": "string", VLAN id for outer tag
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Delete
Delete operation of resource: local-traffic-default-encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
LOCAL-TRAFFIC-DEFAULT-ENCAPSULATION - Retrieve
Retrieve operation of resource: local-traffic-default-encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "outer-tag-type": "string", Type of outer tag
"outer-vlan-id": "string", VLAN id for outer tag
"inner-vlan-id": "string" Optional VLAN Id for inner Dot1Q tag
}
}
ENCAPSULATION - Update
Update operation of resource: encapsulation
encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCAPSULATION - Create
Create operation of resource: encapsulation
encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ENCAPSULATION - Delete
Delete operation of resource: encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ENCAPSULATION - Retrieve
Retrieve operation of resource: encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
REWRITE - Update
Update operation of resource: rewrite
rewritebody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "inner-tag-value": "string", VLAN Id of innermost tag to be pushed
"rewrite-type": "string", The type of rewrite to perform
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed
"inner-tag-type": "string", Type of innermost tag to be pushed
"outer-tag-type": "string" Type of outermost tag to be pushed
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REWRITE - Create
Create operation of resource: rewrite
rewritebody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "inner-tag-value": "string", VLAN Id of innermost tag to be pushed
"rewrite-type": "string", The type of rewrite to perform
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed
"inner-tag-type": "string", Type of innermost tag to be pushed
"outer-tag-type": "string" Type of outermost tag to be pushed
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REWRITE - Delete
Delete operation of resource: rewrite
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
REWRITE - Retrieve
Retrieve operation of resource: rewrite
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "inner-tag-value": "string", VLAN Id of innermost tag to be pushed
"rewrite-type": "string", The type of rewrite to perform
"outer-tag-value": "string", VLAN Id of outermost tag to be pushed
"inner-tag-type": "string", Type of innermost tag to be pushed
"outer-tag-type": "string" Type of outermost tag to be pushed
}
}
ETHERNET-BNG - Update
Update operation of resource: ethernet-bng
ethernet-bngbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-BNG - Create
Create operation of resource: ethernet-bng
ethernet-bngbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-BNG - Delete
Delete operation of resource: ethernet-bng
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-BNG - Retrieve
Retrieve operation of resource: ethernet-bng
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
}
AMBIGUOUS-ENCAPSULATION - Update
Update operation of resource: ambiguous-encapsulation
ambiguous-encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AMBIGUOUS-ENCAPSULATION - Create
Create operation of resource: ambiguous-encapsulation
ambiguous-encapsulationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
Successful operation
Internal Error
Response Content-Types: application/json
AMBIGUOUS-ENCAPSULATION - Delete
Delete operation of resource: ambiguous-encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
AMBIGUOUS-ENCAPSULATION - Retrieve
Retrieve operation of resource: ambiguous-encapsulation
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "ingress-destination-mac": "string", Destination MAC address to match on egress
"additional-range4-high": "string", High value of forth additional range for tag\nmatch
"additional-range1-low": "string", Low value of first additional range for tag\nmatch
"inner-range1-high": "string", High value of first range for inner tag match
"additional-range8-high": "string", High value of eighth additional range for tag\nmatch
"additional-range6-low": "string", Low value of sixth additional range for tag\nmatch
"outer-range1-low": "string", Low value of first range for outer tag match
"inner-tag-type": "string", Type of tag for inner match (if present)
"additional-range3-low": "string", Low value of third additional range for tag\nmatch
"inner-class-of-service": "string", Value to match against Class Of Service bits\nfor inner tag
"additional-range8-low": "string", Low value of eighth additional range for tag\nmatch
"payload-ethertype-match": "string", Which payload ethertype values to match
"additional-range2-low": "string", Low value of second additional range for tag\nmatch
"inner-range1-low": "string", Low value of first range for inner tag match
"additional-range7-high": "string", High value of seventh additional range for tag\nmatch
"outer-class-of-service": "string", Value to match against Class Of Service bits\nfor outer tag
"additional-range3-high": "string", High value of third additional range for tag\nmatch
"ingress-source-mac": "string", Source MAC address to match on ingress
"outer-range1-high": "string", High value of first range for outer tag match
"additional-range7-low": "string", Low value of seventh additional range for tag\nmatch
"additional-range5-high": "string", High value of fifth additional range for tag\nmatch
"additional-range6-high": "string", High value of sixth additional range for tag\nmatch
"outer-tag-type": "string", Whether to match all unmatched packets,\nuntagged packets or tagged packets, and if\nmatching tagged packets, the outer tag type to\nmatch
"additional-range5-low": "string", Low value of fifth additional range for tag\nmatch
"additional-range2-high": "string", High value of second additional range for tag\nmatch
"exact": "null", Only match packets with no more tags than\nexplicitly matched
"additional-range4-low": "string", Low value of forth additional range for tag\nmatch
"additional-range1-high": "string" High value of first additional range for tag\nmatch
}
}
MAC-ACCOUNTING - Update
Update operation of resource: mac-accounting
mac-accountingbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MAC-ACCOUNTING - Create
Create operation of resource: mac-accounting
mac-accountingbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MAC-ACCOUNTING - Delete
Delete operation of resource: mac-accounting
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
MAC-ACCOUNTING - Retrieve
Retrieve operation of resource: mac-accounting
ID of active interface-name
Successful operation
Internal Error
ETHERNET-FEATURES - Update
Update operation of resource: ethernet-features
ethernet-featuresbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"mode": "string", Possible required peer modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement
"session-up": "string", Action to perform when a session comes up
"critical-event": "string", Action to perform when a critical event occurs
"link-fault": "string", Action to perform when a link fault occurs
"high-threshold": "string", Action to perform when a high-threshold event\noccurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"session-down": "string" Action to perform when a session comes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement
"mode": "string", Possible required peer modes
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement
},
"profile-name": "string" Set the profile to use on the interface
},
"filtering": "string" Ingress Ethernet frame filtering
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-FEATURES - Create
Create operation of resource: ethernet-features
ethernet-featuresbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"mode": "string", Possible required peer modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement
"session-up": "string", Action to perform when a session comes up
"critical-event": "string", Action to perform when a critical event occurs
"link-fault": "string", Action to perform when a link fault occurs
"high-threshold": "string", Action to perform when a high-threshold event\noccurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"session-down": "string" Action to perform when a session comes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement
"mode": "string", Possible required peer modes
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement
},
"profile-name": "string" Set the profile to use on the interface
},
"filtering": "string" Ingress Ethernet frame filtering
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-FEATURES - Delete
Delete operation of resource: ethernet-features
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ETHERNET-FEATURES - Retrieve
Retrieve operation of resource: ethernet-features
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "ether-link-oam-enable": "null", Enable Ethernet Link OAM on the interface "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"mode": "string", Possible required peer modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement
"session-up": "string", Action to perform when a session comes up
"critical-event": "string", Action to perform when a critical event occurs
"link-fault": "string", Action to perform when a link fault occurs
"high-threshold": "string", Action to perform when a high-threshold event\noccurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"session-down": "string" Action to perform when a session comes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement
"mode": "string", Possible required peer modes
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement
},
"profile-name": "string" Set the profile to use on the interface
},
"filtering": "string" Ingress Ethernet frame filtering
}
}
ETHER-LINK-OAM - Update
Update operation of resource: ether-link-oam
ether-link-oambody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"mode": "string", Possible required peer modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement
"session-up": "string", Action to perform when a session comes up
"critical-event": "string", Action to perform when a critical event occurs
"link-fault": "string", Action to perform when a link fault occurs
"high-threshold": "string", Action to perform when a high-threshold event\noccurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"session-down": "string" Action to perform when a session comes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement
"mode": "string", Possible required peer modes
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement
},
"profile-name": "string" Set the profile to use on the interface
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHER-LINK-OAM - Create
Create operation of resource: ether-link-oam
ether-link-oambody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"mode": "string", Possible required peer modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement
"session-up": "string", Action to perform when a session comes up
"critical-event": "string", Action to perform when a critical event occurs
"link-fault": "string", Action to perform when a link fault occurs
"high-threshold": "string", Action to perform when a high-threshold event\noccurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"session-down": "string" Action to perform when a session comes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement
"mode": "string", Possible required peer modes
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement
},
"profile-name": "string" Set the profile to use on the interface
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ETHER-LINK-OAM - Delete
Delete operation of resource: ether-link-oam
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ETHER-LINK-OAM - Retrieve
Retrieve operation of resource: ether-link-oam
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
},
"udlf": "boolean", Enable or disable uni-directional link-fault\ndetection
"hello-interval": "string", Possible Ethernet Link OAM hello intervals
"remote-loopback": "boolean", Enable or disable remote loopback peer\nrequirement
"mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"mode": "string", Possible required peer modes
"timeout": "integer", Connection timeout period in number of lost\nheartbeats
range: "1..600000"
units: "millisecond" "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs
"remote-loopback": "string", Enable or disable remote loopback peer\nrequirement
"session-up": "string", Action to perform when a session comes up
"critical-event": "string", Action to perform when a critical event occurs
"link-fault": "string", Action to perform when a link fault occurs
"high-threshold": "string", Action to perform when a high-threshold event\noccurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"session-down": "string" Action to perform when a session comes down
}, "mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement
"mode": "string", Possible required peer modes
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement
},
"profile-name": "string" Set the profile to use on the interface
}
}
ACTION - Update
Update operation of resource: action
actionbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs
"remote-loopback": "string", Action to perform when remote loopback is\nentered or exited
"session-up": "string", Action to perform when a session comes up
"critical-event": "string", Action to perform when a critical event occurs
"link-fault": "string", Action to perform when a link fault occurs
"high-threshold": "string", Action to perform when a high-threshold event\noccurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"session-down": "string" Action to perform when a session comes down
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION - Create
Create operation of resource: action
actionbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs
"remote-loopback": "string", Action to perform when remote loopback is\nentered or exited
"session-up": "string", Action to perform when a session comes up
"critical-event": "string", Action to perform when a critical event occurs
"link-fault": "string", Action to perform when a link fault occurs
"high-threshold": "string", Action to perform when a high-threshold event\noccurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"session-down": "string" Action to perform when a session comes down
}
}
Successful operation
Internal Error
Response Content-Types: application/json
ACTION - Delete
Delete operation of resource: action
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
ACTION - Retrieve
Retrieve operation of resource: action
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "dying-gasp": "string", Action to perform when a dying gasp occurs
"capabilities-conflict": "string", Action to perform when a capabilities conflict\noccurs
"remote-loopback": "string", Action to perform when remote loopback is\nentered or exited
"session-up": "string", Action to perform when a session comes up
"critical-event": "string", Action to perform when a critical event occurs
"link-fault": "string", Action to perform when a link fault occurs
"high-threshold": "string", Action to perform when a high-threshold event\noccurs
"wiring-conflict": "string", Action to perform when a wiring conflict\noccurs
"discovery-timeout": "string", Action to perform when discovery timeout\noccurs
"session-down": "string" Action to perform when a session comes down
}
}
REQUIRE-REMOTE - Update
Update operation of resource: require-remote
require-remotebody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement
"mode": "string", Possible required peer modes
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REQUIRE-REMOTE - Create
Create operation of resource: require-remote
require-remotebody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement
"mode": "string", Possible required peer modes
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement
}
}
Successful operation
Internal Error
Response Content-Types: application/json
REQUIRE-REMOTE - Delete
Delete operation of resource: require-remote
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
REQUIRE-REMOTE - Retrieve
Retrieve operation of resource: require-remote
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "mib-retrieval": "boolean", Enable or disable MIB retrieval peer\nrequirement
"link-monitoring": "boolean", Enable or disable link monitoring peer\nrequirement
"mode": "string", Possible required peer modes
"remote-loopback": "boolean" Enable or disable remote loopback peer\nrequirement
}
}
LINK-MONITORING - Update
Update operation of resource: link-monitoring
link-monitoringbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-MONITORING - Create
Create operation of resource: link-monitoring
link-monitoringbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
LINK-MONITORING - Delete
Delete operation of resource: link-monitoring
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
LINK-MONITORING - Retrieve
Retrieve operation of resource: link-monitoring
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
},
"monitoring": "boolean", Enable or disable monitoring "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
},
"window": "integer" Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
}, "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
}
}
SYMBOL-PERIOD - Update
Update operation of resource: symbol-period
symbol-periodbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for symbol-period
range: "1..4294967295"
units: "second"
"units": "string", Units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for symbol-period
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)
}, "units": "string", Units to use for this window
"window": "integer", Size of the symbol-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Symbols and treated as 1\nif unspecified)
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYMBOL-PERIOD - Create
Create operation of resource: symbol-period
symbol-periodbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for symbol-period
range: "1..4294967295"
units: "second"
"units": "string", Units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for symbol-period
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)
}, "units": "string", Units to use for this window
"window": "integer", Size of the symbol-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Symbols and treated as 1\nif unspecified)
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
SYMBOL-PERIOD - Delete
Delete operation of resource: symbol-period
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
SYMBOL-PERIOD - Retrieve
Retrieve operation of resource: symbol-period
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for symbol-period
range: "1..4294967295"
units: "second"
"units": "string", Units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for symbol-period
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Symbols and treated\nas 1 if unspecified)
}, "units": "string", Units to use for this window
"window": "integer", Size of the symbol-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Symbols and treated as 1\nif unspecified)
}
}
}
WINDOW - Update
Update operation of resource: window
windowbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Create
Create operation of resource: window
windowbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Delete
Delete operation of resource: window
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Retrieve
Retrieve operation of resource: window
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
FRAME-PERIOD - Update
Update operation of resource: frame-period
frame-periodbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-PERIOD - Create
Create operation of resource: frame-period
frame-periodbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-PERIOD - Delete
Delete operation of resource: frame-period
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-PERIOD - Retrieve
Retrieve operation of resource: frame-period
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for frame-period events
range: "1..4294967295"
units: "second"
"units": "string", The units to use for this window
"multiplier-low": "string", The multiplier to use for the low threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
"threshold-low": "integer", The low threshold for frame-period events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(only valid if 'Units' is Frames and treated\nas 1 if unspecified)
}, "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
}
WINDOW - Update
Update operation of resource: window
windowbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Create
Create operation of resource: window
windowbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Delete
Delete operation of resource: window
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
WINDOW - Retrieve
Retrieve operation of resource: window
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "units": "string", The units to use for this window
"window": "integer", Size of the frame-period window
range: "1000..60000"
units: "millisecond"
default: "60000"
"multiplier": "string" The multiplier to use for this window (only\nvalid if 'Units' is Frames and treated as 1\nif unspecified)
}
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
FRAME-SECONDS - Update
Update operation of resource: frame-seconds
frame-secondsbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-SECONDS - Create
Create operation of resource: frame-seconds
frame-secondsbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"
}
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-SECONDS - Delete
Delete operation of resource: frame-seconds
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
FRAME-SECONDS - Retrieve
Retrieve operation of resource: frame-seconds
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"
}
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
FRAME - Update
Update operation of resource: frame
framebody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ : {Threshold configuration for frame-seconds\nevents "threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME - Create
Create operation of resource: frame
framebody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ : {Threshold configuration for frame-seconds\nevents "threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"
}
Successful operation
Internal Error
Response Content-Types: application/json
FRAME - Delete
Delete operation of resource: frame
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
FRAME - Retrieve
Retrieve operation of resource: frame
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ : {Threshold configuration for frame-seconds\nevents "threshold-high": "integer", The high threshold for frame-seconds events
range: "1..4294967295"
units: "second"
"threshold-low": "integer" The low threshold for frame-seconds events
range: "1..4294967295"
units: "second"
default: "1"
},
"window": "integer" Window size configuration for frame-seconds\nevents
range: "1000..60000"
units: "millisecond"
default: "60000"
}
THRESHOLD - Update
Update operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Create
Create operation of resource: threshold
thresholdbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Delete
Delete operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
THRESHOLD - Retrieve
Retrieve operation of resource: threshold
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "threshold-high": "integer", The high threshold for frame events
range: "1..4294967295"
units: "second"
"multiplier-low": "string", The multiplier to use for the low threshold\n(treated as 1 if unspecified)
"threshold-low": "integer", The low threshold for frame events
range: "1..4294967295"
units: "second"
default: "1"
"multiplier-high": "string" The multiplier to use for the high threshold\n(treated as 1 if unspecified)
}
}
CARRIER-DELAY - Update
Update operation of resource: carrier-delay
carrier-delaybody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CARRIER-DELAY - Create
Create operation of resource: carrier-delay
carrier-delaybody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CARRIER-DELAY - Delete
Delete operation of resource: carrier-delay
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
CARRIER-DELAY - Retrieve
Retrieve operation of resource: carrier-delay
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "carrier-delay-up": "integer", Carrier Delay (up) in msecs
range: "1..65535"
"carrier-delay-down": "integer" Carrier Delay down in msecs, must be set to 0
}
}
VLAN-TRUNK-CONFIGURATION - Update
Update operation of resource: vlan-trunk-configuration
vlan-trunk-configurationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "vlan-type": "string", Whether this interface is dot1ad or dot1Q
"vlan-identifier": "string" VLAN identifier
},
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-TRUNK-CONFIGURATION - Create
Create operation of resource: vlan-trunk-configuration
vlan-trunk-configurationbody object
ID of active interface-name
Request Content-Types: application/json
Request Example
{ "vlan-type": "string", Whether this interface is dot1ad or dot1Q
"vlan-identifier": "string" VLAN identifier
},
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100
}
}
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-TRUNK-CONFIGURATION - Delete
Delete operation of resource: vlan-trunk-configuration
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
VLAN-TRUNK-CONFIGURATION - Retrieve
Retrieve operation of resource: vlan-trunk-configuration
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{ "vlan-type": "string", Whether this interface is dot1ad or dot1Q
"vlan-identifier": "string" VLAN identifier
},
"tunneling-ethertype": "string" The outer ethertype used in Q-in-Q frames. The\ndefault value is 0x8100
}
}
NATIVE-VLAN-IDENTIFIER - Update
Update operation of resource: native-vlan-identifier
native-vlan-identifierbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NATIVE-VLAN-IDENTIFIER - Create
Create operation of resource: native-vlan-identifier
native-vlan-identifierbody object
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NATIVE-VLAN-IDENTIFIER - Delete
Delete operation of resource: native-vlan-identifier
ID of active interface-name
Successful operation
Internal Error
Response Content-Types: application/json
NATIVE-VLAN-IDENTIFIER - Retrieve
Retrieve operation of resource: native-vlan-identifier
ID of active interface-name
Successful operation
Internal Error